<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_09) on Sat Dec 29 12:31:13 CET 2012 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>SearchReplaceController (gephi 0.8.2 API)</title>
<meta name="date" content="2012-12-29">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
    if (location.href.indexOf('is-external=true') == -1) {
        parent.document.title="SearchReplaceController (gephi 0.8.2 API)";
    }
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!--   -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/SearchReplaceController.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/gephi/datalab/api/GraphElementsController.html" title="interface in org.gephi.datalab.api"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/gephi/datalab/api/SearchReplaceController.SearchOptions.html" title="class in org.gephi.datalab.api"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/gephi/datalab/api/SearchReplaceController.html" target="_top">Frames</a></li>
<li><a href="SearchReplaceController.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested_class_summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!--   -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.gephi.datalab.api</div>
<h2 title="Interface SearchReplaceController" class="title">Interface SearchReplaceController</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="strong">SearchReplaceController</span></pre>
<div class="block"><p>Independent controller for search/replace feature.</p>
 <p>Operates with <code>SearchOptions</code> and <code>SearchResult</code> objects.</p></div>
<dl><dt><span class="strong">Author:</span></dt>
  <dd>Eduardo Ramos <eduramiba@gmail.com></dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested_class_summary">
<!--   -->
</a>
<h3>Nested Class Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Interface and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/datalab/api/SearchReplaceController.SearchOptions.html" title="class in org.gephi.datalab.api">SearchReplaceController.SearchOptions</a></strong></code>
<div class="block">Class that wraps the different possible options of search and provides various useful constructors.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/datalab/api/SearchReplaceController.SearchResult.html" title="class in org.gephi.datalab.api">SearchReplaceController.SearchResult</a></strong></code>
<div class="block">Class that wraps the result of a search contaning the search options used for this result
 and the node or edge, row, column and start-end index of the value where ocurrence was found.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!--   -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/datalab/api/SearchReplaceController.html#canReplace(org.gephi.datalab.api.SearchReplaceController.SearchResult)">canReplace</a></strong>(<a href="../../../../org/gephi/datalab/api/SearchReplaceController.SearchResult.html" title="class in org.gephi.datalab.api">SearchReplaceController.SearchResult</a>&nbsp;result)</code>
<div class="block">Indicates if a <code>SearchResult</code> can be replaced or not.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/gephi/datalab/api/SearchReplaceController.SearchResult.html" title="class in org.gephi.datalab.api">SearchReplaceController.SearchResult</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/datalab/api/SearchReplaceController.html#findNext(org.gephi.datalab.api.SearchReplaceController.SearchOptions)">findNext</a></strong>(<a href="../../../../org/gephi/datalab/api/SearchReplaceController.SearchOptions.html" title="class in org.gephi.datalab.api">SearchReplaceController.SearchOptions</a>&nbsp;searchOptions)</code>
<div class="block">Finds next (or first) ocurrence for the given search options.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/gephi/datalab/api/SearchReplaceController.SearchResult.html" title="class in org.gephi.datalab.api">SearchReplaceController.SearchResult</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/datalab/api/SearchReplaceController.html#findNext(org.gephi.datalab.api.SearchReplaceController.SearchResult)">findNext</a></strong>(<a href="../../../../org/gephi/datalab/api/SearchReplaceController.SearchResult.html" title="class in org.gephi.datalab.api">SearchReplaceController.SearchResult</a>&nbsp;result)</code>
<div class="block">Finds next ocurrence for the given search options contained in a SearchResult.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/gephi/datalab/api/SearchReplaceController.SearchResult.html" title="class in org.gephi.datalab.api">SearchReplaceController.SearchResult</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/datalab/api/SearchReplaceController.html#replace(org.gephi.datalab.api.SearchReplaceController.SearchResult, java.lang.String)">replace</a></strong>(<a href="../../../../org/gephi/datalab/api/SearchReplaceController.SearchResult.html" title="class in org.gephi.datalab.api">SearchReplaceController.SearchResult</a>&nbsp;result,
       <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;replacement)</code>
<div class="block">Replaces a <code>SearchResult</code> with the given replacement String.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/datalab/api/SearchReplaceController.html#replaceAll(org.gephi.datalab.api.SearchReplaceController.SearchOptions, java.lang.String)">replaceAll</a></strong>(<a href="../../../../org/gephi/datalab/api/SearchReplaceController.SearchOptions.html" title="class in org.gephi.datalab.api">SearchReplaceController.SearchOptions</a>&nbsp;searchOptions,
          <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;replacement)</code>
<div class="block">Replaces all SearchResults that can be replaced with the given search options from the beginning to the end of the data.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a name="findNext(org.gephi.datalab.api.SearchReplaceController.SearchOptions)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>findNext</h4>
<pre><a href="../../../../org/gephi/datalab/api/SearchReplaceController.SearchResult.html" title="class in org.gephi.datalab.api">SearchReplaceController.SearchResult</a>&nbsp;findNext(<a href="../../../../org/gephi/datalab/api/SearchReplaceController.SearchOptions.html" title="class in org.gephi.datalab.api">SearchReplaceController.SearchOptions</a>&nbsp;searchOptions)</pre>
<div class="block"><p>Finds next (or first) ocurrence for the given search options.</p>
 <p>Returns a <code>SearchResult</code> instance with the details or null if the search was not successful.</p>
 <p>Modifies the given search options in order to match the next result the next time <code>findNext</code> is called</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>searchOptions</code> - Options of the search</dd>
<dt><span class="strong">Returns:</span></dt><dd>SearchResult with details of the match or null</dd></dl>
</li>
</ul>
<a name="findNext(org.gephi.datalab.api.SearchReplaceController.SearchResult)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>findNext</h4>
<pre><a href="../../../../org/gephi/datalab/api/SearchReplaceController.SearchResult.html" title="class in org.gephi.datalab.api">SearchReplaceController.SearchResult</a>&nbsp;findNext(<a href="../../../../org/gephi/datalab/api/SearchReplaceController.SearchResult.html" title="class in org.gephi.datalab.api">SearchReplaceController.SearchResult</a>&nbsp;result)</pre>
<div class="block"><p>Finds next ocurrence for the given search options contained in a SearchResult.</p>
 <p>Returns a <code>SearchResult</code> instance with the details or null if the search was not successful.</p>
 <p>Modifies the given search options in order to match the next result the next time <code>findNext</code> is called</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>result</code> - Last result of the search</dd>
<dt><span class="strong">Returns:</span></dt><dd>SearchResult with details of the match or null</dd></dl>
</li>
</ul>
<a name="canReplace(org.gephi.datalab.api.SearchReplaceController.SearchResult)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>canReplace</h4>
<pre>boolean&nbsp;canReplace(<a href="../../../../org/gephi/datalab/api/SearchReplaceController.SearchResult.html" title="class in org.gephi.datalab.api">SearchReplaceController.SearchResult</a>&nbsp;result)</pre>
<div class="block"><p>Indicates if a <code>SearchResult</code> can be replaced or not.</p>
 <p>Computed columns and id columns cannot be replaced.</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>result</code> - SearchResult to check before replacing</dd>
<dt><span class="strong">Returns:</span></dt><dd>True if it can be replaced, false otherwise</dd></dl>
</li>
</ul>
<a name="replace(org.gephi.datalab.api.SearchReplaceController.SearchResult, java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>replace</h4>
<pre><a href="../../../../org/gephi/datalab/api/SearchReplaceController.SearchResult.html" title="class in org.gephi.datalab.api">SearchReplaceController.SearchResult</a>&nbsp;replace(<a href="../../../../org/gephi/datalab/api/SearchReplaceController.SearchResult.html" title="class in org.gephi.datalab.api">SearchReplaceController.SearchResult</a>&nbsp;result,
                                           <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;replacement)</pre>
<div class="block"><p>Replaces a <code>SearchResult</code> with the given replacement String.</p>
 <p>Also tries to find next search result and returns it.</p>
 <p>If the data has changed and the replacement can't be done it will just return next <code>SearchResult</code> calling <code>findNext</code>.</p>
 <p>If useRegexReplaceMode is enabled, IndexOutOfBoundsException can be thrown when the replacement is not correct for the regular expression.</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>result</code> - SearchResult to replace</dd><dd><code>replacement</code> - Replacement String</dd>
<dt><span class="strong">Returns:</span></dt><dd>Next SearchResult or null if not successful</dd></dl>
</li>
</ul>
<a name="replaceAll(org.gephi.datalab.api.SearchReplaceController.SearchOptions, java.lang.String)">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>replaceAll</h4>
<pre>int&nbsp;replaceAll(<a href="../../../../org/gephi/datalab/api/SearchReplaceController.SearchOptions.html" title="class in org.gephi.datalab.api">SearchReplaceController.SearchOptions</a>&nbsp;searchOptions,
             <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;replacement)</pre>
<div class="block"><p>Replaces all SearchResults that can be replaced with the given search options from the beginning to the end of the data.</p>
 <p>If useRegexReplaceMode is enabled, IndexOutOfBoundsException can be thrown when the replacement is not correct for the regular expression.</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>searchOptions</code> - Search options for the searches</dd><dd><code>replacement</code> - Replacement String</dd>
<dt><span class="strong">Returns:</span></dt><dd>Count of made replacements</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!--   -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/SearchReplaceController.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/gephi/datalab/api/GraphElementsController.html" title="interface in org.gephi.datalab.api"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/gephi/datalab/api/SearchReplaceController.SearchOptions.html" title="class in org.gephi.datalab.api"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/gephi/datalab/api/SearchReplaceController.html" target="_top">Frames</a></li>
<li><a href="SearchReplaceController.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested_class_summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!--   -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2007-2012 <a href="http://consortium.gephi.org">Gephi Consortium</a>. All Rights Reserved.</small></p>
</body>
</html>
